Notificaciones

Las notificaciones son un mecanismo para obtener directamente el estado de los mensajes enviados.

Te permiten obtener información relevante, como la cantidad de mensajes leídos de tus mensajes individuales, en masa o de tu campaña.

Al utilizar las notificaciones, puedes conocer el comportamiento del usuario y usar esa información para mejorar tu campaña de marketing o elegir un mejor Tipo de dato de mensaje para ser más preciso en tus comunicaciones. Puedes obtener información específica de una notificación mediante su ID o todas las notificaciones para llenar tu base de datos o tu Panel de Control, y así tomar mejores decisiones o actuar posteriormente.

Obtener Notificación por ID

Este endpoint te permite obtener una notificación enviada previamente proporcionando el ID de la notificación.

**GET** https://api.jelou.ai/v1/bots/:botId/notifications/:notificationId

Parámetros de la Ruta

Propiedad	Tipo de dato	Descripción
notificationId*	string	ID de la notificación.
botId*	string	ID del bot.

Encabezados

Propiedad	Tipo de dato	Descripción
Authentication	string	Token de autenticación.

Ejemplo de cURL

{
  "method": "GET",
  "url": "https://api.jelou.ai/v1/bots/:botId/notifications/:notificationId",
  "headers": {
    "Authorization": "Bearer YOUR_AUTH_TOKEN"
  }
}

Obtener Notificaciones

Este endpoint permite obtener notificaciones enviadas previamente.

**GET** https://api.jelou.ai/v1/bots/:botId/notifications

Parámetros de Ruta (Path Parameters)

Propiedad	Tipo de dato	Descripción
botId	string	ID del bot.

Parámetros de Consulta (Query Parameters)

Propiedad	Tipo de dato	Descripción
download	boolean	Descargar el archivo.
campaignId	string	ID de la campaña.
elementName	string	Propiedad del elemento.
from	date	Fecha de inicio.
to	date	Fecha de fin.
limit	number	Límite de paginación (Máx: 50).
page	number	Número de página (Por defecto: 1).

Ejemplo de Solicitud (API de ejemplo)

curl --request GET \
  --url 'https://api.jelou.ai/v1/bots/BOT_ID/notifications?limit=PAGE_LIMIT&from=START_AT&to=END_AT&page=PAGE_NUMBER' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}'

Lista de Estados de Mensajes

Estado	Descripción
DELIVERED_CHANNEL	El mensaje fue recibido por WhatsApp.
DELIVERED_USER	El mensaje fue recibido por el usuario.
READ	El usuario leyó el mensaje.
REPLY	El usuario respondió al mensaje.
CREATED	El mensaje fue recibido por Jelou.
FAILED	El mensaje no pudo ser entregado.

Estado de Lectura del Mensaje

Estado	Descripción
true	El usuario leyó el mensaje.
false	El usuario no ha leído el mensaje.

Ejemplo de Respuestas de la API

El payload contiene los siguientes campos:

Propiedad	Descripción
status	Estado de entrega de la plantilla.
timestamp	Fecha del evento en milisegundos (ms).
destination	Número de teléfono del usuario.
id	ID del mensaje.
error	Motivo del fallo en la entrega de la plantilla (si aplica).
reply	Respuesta del usuario (disponible cuando el estado es REPLY).

Estatus

Canal entregado

{
  "status": "DELIVERED_CHANNEL",
  "timestamp": 1672320999889,
  "isFinalEvent": true,
  "destination": "593912345678",
  "id": "86e9e0e5-123-4ef6-567-ab42363910"
}

Usuario entregado

{
  "status": "DELIVERED_USER",
  "timestamp": 1672326431552,
  "isFinalEvent": true,
  "destination": "593912345678",
  "id": "86e9e0e5-123-4ef6-567-ab42363910"
}

Mensaje leído

{
  "status": "READ",
  "timestamp": 1672331937335,
  "isFinalEvent": true,
  "destination": "593912345678",
  "id": "86e9e0e5-123-4ef6-567-ab42363910"
}

Respuesta

{
  "reply": "Hello",
  "id": "86e9e0e5-123-4ef6-567-ab42363910",
  "timestamp": 1672329944349,
  "status": "REPLY",
  "isFinalEvent": true,
  "destination": "593912345678"
}

Creado

{
  "status": "CREATED",
  "timestamp": 1672160621946,
  "isFinalEvent": true,
  "destination": "593912345678",
  "id": "86e9e0e5-123-4ef6-567-ab42363910"
}

Fallido

{
  "status": "FAILED",
  "timestamp": 1672160621946,
  "isFinalEvent": true,
  "destination": "593912345678",
  "id": "86e9e0e5-123-4ef6-567-ab42363910",
  "error": "Number Does Not Exists On WhatsApp"
}